| Package | ca.infoway.io.cafex |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=ca.infoway.io.cafex@2.2.0-DFT-Ballot&canonical=http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-B |
| Url | http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-B |
| Version | 2.2.0 |
| Status | draft |
| Date | 2025-04-02 |
| Name | CAFEX_DataConsumer_Option_B |
| Title | CA:FeX CapabilityStatement - Data Consumer - Option B (Metadata Option) |
| Experimental | False |
| Realm | ca |
| Authority | national |
| Description | CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Consumer implementing the Metadata Option (B). This system must support the use of the $docref operation to retrieve DocumentReference metadata, and subsequent retrieval of referenced documents via the attachment.url. Only /Bundle and /Binary endpoints are expected in CA:FeX for document retrieval. |
| Copyright | Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy). |
| Kind | requirements |
No resources found
No resources found
FHIR{
"resourceType" : "CapabilityStatement",
"id" : "CaFeX-DataConsumer-Option-B",
"url" : "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-B",
"version" : "2.2.0",
"name" : "CAFEX_DataConsumer_Option_B",
"title" : "CA:FeX CapabilityStatement - Data Consumer - Option B (Metadata Option)",
"status" : "draft",
"experimental" : false,
"date" : "2025-04-02",
"publisher" : "Canada Health Infoway",
"contact" : [
{
"name" : "National Standards Release Centre",
"telecom" : [
{
"system" : "url",
"value" : "http://www.infoway-inforoute.ca"
},
{
"system" : "email",
"value" : "standards@infoway-inforoute.ca"
}
]
}
],
"description" : "CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Consumer implementing the Metadata Option (B).\nThis system must support the use of the $docref operation to retrieve DocumentReference metadata,\nand subsequent retrieval of referenced documents via the attachment.url.\nOnly /Bundle and /Binary endpoints are expected in CA:FeX for document retrieval.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "CA"
}
]
}
],
"copyright" : "Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "client",
"documentation" : "This client supports CA:FeX-2B and CA:FeX-3B. The client initiates a $docref operation against a DocumentReference endpoint\nand retrieves documents using the attachment.url found in the response.\nThe client SHALL support reading both Bundle and Binary resources.",
"security" : {
"description" : "1. See the security section of the CA:FeX guide for security requirements and recommendations.\n2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` \"Unauthorized\", `HTTP 403` \"Forbidden\", or `HTTP 404` \"Not Found\""
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "DocumentReference",
"interaction" : [
{
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "author",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-author",
"type" : "reference"
}
]
},
{
"type" : "Bundle",
"documentation" : "This client retrieves Bundle resources as referenced from DocumentReference.attachment.url. These are used when the document is submitted as a FHIR document.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"type" : "Binary",
"documentation" : "This client retrieves Binary resources as referenced from DocumentReference.attachment.url. These are typically used to return non-structured documents (PDF, CDA).",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "$docref",
"definition" : "http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/docref"
}
]
}
],
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.